<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>v_hdmirxss: xv_hdmirxss_log.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">v_hdmirxss
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xv__hdmirxss__log_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xv_hdmirxss_log.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><dl class="section note"><dt>Note</dt><dd>None.</dd></dl>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
</p>
<hr/>
<p>
1.0   YH   17/08/16 Initial release.
1.01  MMO  03/01/17 Add compiler option(XV_HDMIRXSS_LOG_ENABLE) to enable
                        Log
1.4   YH   07/07/17 Add new log type XV_HDMIRXSS_LOG_EVT_SETSTREAM_ERR
5.0   EB   16/01/18 Added new log XV_HDMIRXSS_LOG_EVT_PIX_REPEAT_ERR
           23/01/18 Minor cleanup
      MMO  05/02/18 Added new log XV_HDMIRXSS_LOG_EVT_SYNCEST
5.4   EB   06/08/19 Added new log XV_HDMIRXSS_LOG_EVT_VICERROR
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a1c4367511513d15ca3b13fd6f77143ec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__hdmirxss__log_8c.html#a1c4367511513d15ca3b13fd6f77143ec">XV_HdmiRxSs_LogReset</a> (<a class="el" href="struct_x_v___hdmi_rx_ss.html">XV_HdmiRxSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a1c4367511513d15ca3b13fd6f77143ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will reset the driver's logging mechanism.  <a href="#a1c4367511513d15ca3b13fd6f77143ec">More...</a><br/></td></tr>
<tr class="separator:a1c4367511513d15ca3b13fd6f77143ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56c28560c5de8682b22f96d40fa4e24d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__hdmirxss__log_8c.html#a56c28560c5de8682b22f96d40fa4e24d">XV_HdmiRxSs_LogWrite</a> (<a class="el" href="struct_x_v___hdmi_rx_ss.html">XV_HdmiRxSs</a> *InstancePtr, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15">XV_HdmiRxSs_LogEvent</a> Evt, u8 Data)</td></tr>
<tr class="memdesc:a56c28560c5de8682b22f96d40fa4e24d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will insert an event in the driver's logginc mechanism.  <a href="#a56c28560c5de8682b22f96d40fa4e24d">More...</a><br/></td></tr>
<tr class="separator:a56c28560c5de8682b22f96d40fa4e24d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a5bd0ad2a900d4d43eeab77ac3e43ac"><td class="memItemLeft" align="right" valign="top">u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__hdmirxss__log_8c.html#a7a5bd0ad2a900d4d43eeab77ac3e43ac">XV_HdmiRxSs_LogRead</a> (<a class="el" href="struct_x_v___hdmi_rx_ss.html">XV_HdmiRxSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a7a5bd0ad2a900d4d43eeab77ac3e43ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will read the last event from the log.  <a href="#a7a5bd0ad2a900d4d43eeab77ac3e43ac">More...</a><br/></td></tr>
<tr class="separator:a7a5bd0ad2a900d4d43eeab77ac3e43ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b9bb4c33be5af21747548422b4c617c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__hdmirxss__log_8c.html#a3b9bb4c33be5af21747548422b4c617c">XV_HdmiRxSs_LogDisplay</a> (<a class="el" href="struct_x_v___hdmi_rx_ss.html">XV_HdmiRxSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a3b9bb4c33be5af21747548422b4c617c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will print the entire log.  <a href="#a3b9bb4c33be5af21747548422b4c617c">More...</a><br/></td></tr>
<tr class="separator:a3b9bb4c33be5af21747548422b4c617c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a3b9bb4c33be5af21747548422b4c617c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HdmiRxSs_LogDisplay </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___hdmi_rx_ss.html">XV_HdmiRxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will print the entire log. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_v___hdmi_rx_ss.html" title="The XVprocss driver instance data. ">XV_HdmiRxSs</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15a9eb981306ed098ffff9be38ab01c1517">XV_HDMIRXSS_LOG_EVT_CONNECT</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15a5f135a325a55a42537d1fe42a7305aad">XV_HDMIRXSS_LOG_EVT_DISCONNECT</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15a316618fc239a38ab4ba0b1700450e0f4">XV_HDMIRXSS_LOG_EVT_DVIMODE</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15af3d29a9e306ac35906881de97ea96b2d">XV_HDMIRXSS_LOG_EVT_HDCP14</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15adb49363476013e89c20d3afc51aa775a">XV_HDMIRXSS_LOG_EVT_HDCP14_INIT</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15a84fe6a6bcd3807a6f5052b4d9a59010b">XV_HDMIRXSS_LOG_EVT_HDCP22</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15a59fd857adf563c600f1a7ca79929711e">XV_HDMIRXSS_LOG_EVT_HDCP22_INIT</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15a054760a76f796027f8cf025b46952509">XV_HDMIRXSS_LOG_EVT_HDCPTIMER_INIT</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15a237bec8d4f235c7404d53dd488056b17">XV_HDMIRXSS_LOG_EVT_HDMIMODE</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15a2f55e7055697853c5389443a0527c505">XV_HDMIRXSS_LOG_EVT_HDMIRX_INIT</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15aee12765ad4c6a164b7368fadf1123c3a">XV_HDMIRXSS_LOG_EVT_LINKSTATUS</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15ad647860e438f48a9e17945b3643edba6">XV_HDMIRXSS_LOG_EVT_NONE</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15aca19273252946ec4a47ccc13efada7fd">XV_HDMIRXSS_LOG_EVT_PIX_REPEAT_ERR</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15a9703ad76bc27e43a049a13ee81dc235a">XV_HDMIRXSS_LOG_EVT_REFCLOCKCHANGE</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15ab484e1c8a94a2b261abda95ff93179e9">XV_HDMIRXSS_LOG_EVT_RESET</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15a86cd289bd97f705a1b5c7327047b928c">XV_HDMIRXSS_LOG_EVT_SETSTREAM</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15a025e9ebc6c9fc794a24b81c71fbaf7ee">XV_HDMIRXSS_LOG_EVT_SETSTREAM_ERR</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15a458e1c5899c17758201f66c0141ff8f7">XV_HDMIRXSS_LOG_EVT_START</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15ad7a14f627e46195aff377cac583106d7">XV_HDMIRXSS_LOG_EVT_STOP</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15ac7a34ea100510d48389285150eac34ab">XV_HDMIRXSS_LOG_EVT_STREAMDOWN</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15a72f5c5220a5d12997ce99ba12b319e48">XV_HDMIRXSS_LOG_EVT_STREAMINIT</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15a88abfe8933839190302c4ef9f2c3b4b2">XV_HDMIRXSS_LOG_EVT_STREAMUP</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15a3df268d692b5be88acf20c37ac15709d">XV_HDMIRXSS_LOG_EVT_SYNCEST</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15a0abb5026b485d00a8e47e2a654ce8fa0">XV_HDMIRXSS_LOG_EVT_SYNCLOSS</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15ab4b2c5a8b53ad68d642cd2df015dc7dc">XV_HDMIRXSS_LOG_EVT_VICERROR</a>, <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15ae52c472c02bfa6ad4c2352d02140cecf">XV_HDMIRXSS_LOG_EVT_VTC_INIT</a>, and <a class="el" href="xv__hdmirxss_8h.html#a7a5bd0ad2a900d4d43eeab77ac3e43ac">XV_HdmiRxSs_LogRead()</a>.</p>

</div>
</div>
<a class="anchor" id="a7a5bd0ad2a900d4d43eeab77ac3e43ac"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u16 XV_HdmiRxSs_LogRead </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___hdmi_rx_ss.html">XV_HdmiRxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will read the last event from the log. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_v___hdmi_rx_ss.html" title="The XVprocss driver instance data. ">XV_HdmiRxSs</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The log data.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___hdmi_rx_ss___log.html#a8c9419f9b31d006d30ec0aef79cb9a29">XV_HdmiRxSs_Log::DataBuffer</a>, <a class="el" href="struct_x_v___hdmi_rx_ss___log.html#ae329bb88bfdcda126c89890443a66a8e">XV_HdmiRxSs_Log::HeadIndex</a>, <a class="el" href="struct_x_v___hdmi_rx_ss.html#acfe6927763f451fd1648926fcfb2cc37">XV_HdmiRxSs::Log</a>, and <a class="el" href="struct_x_v___hdmi_rx_ss___log.html#a88f784a8fadd929060a2d86c9c7afe3b">XV_HdmiRxSs_Log::TailIndex</a>.</p>

<p>Referenced by <a class="el" href="xv__hdmirxss__log_8c.html#a3b9bb4c33be5af21747548422b4c617c">XV_HdmiRxSs_LogDisplay()</a>.</p>

</div>
</div>
<a class="anchor" id="a1c4367511513d15ca3b13fd6f77143ec"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HdmiRxSs_LogReset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___hdmi_rx_ss.html">XV_HdmiRxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will reset the driver's logging mechanism. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the xv_hdmirxss core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___hdmi_rx_ss___log.html#ae329bb88bfdcda126c89890443a66a8e">XV_HdmiRxSs_Log::HeadIndex</a>, <a class="el" href="struct_x_v___hdmi_rx_ss.html#acfe6927763f451fd1648926fcfb2cc37">XV_HdmiRxSs::Log</a>, and <a class="el" href="struct_x_v___hdmi_rx_ss___log.html#a88f784a8fadd929060a2d86c9c7afe3b">XV_HdmiRxSs_Log::TailIndex</a>.</p>

</div>
</div>
<a class="anchor" id="a56c28560c5de8682b22f96d40fa4e24d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HdmiRxSs_LogWrite </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___hdmi_rx_ss.html">XV_HdmiRxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15">XV_HdmiRxSs_LogEvent</a>&#160;</td>
          <td class="paramname"><em>Evt</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>Data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will insert an event in the driver's logginc mechanism. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_v___hdmi_rx_ss.html" title="The XVprocss driver instance data. ">XV_HdmiRxSs</a> core instance. </td></tr>
    <tr><td class="paramname">Evt</td><td>is the event type to log. </td></tr>
    <tr><td class="paramname">Data</td><td>is the associated data for the event.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___hdmi_rx_ss___log.html#a8c9419f9b31d006d30ec0aef79cb9a29">XV_HdmiRxSs_Log::DataBuffer</a>, <a class="el" href="struct_x_v___hdmi_rx_ss___log.html#ae329bb88bfdcda126c89890443a66a8e">XV_HdmiRxSs_Log::HeadIndex</a>, <a class="el" href="struct_x_v___hdmi_rx_ss.html#acfe6927763f451fd1648926fcfb2cc37">XV_HdmiRxSs::Log</a>, <a class="el" href="struct_x_v___hdmi_rx_ss___log.html#a88f784a8fadd929060a2d86c9c7afe3b">XV_HdmiRxSs_Log::TailIndex</a>, and <a class="el" href="xv__hdmirxss_8h.html#a801bb980bfbb34a0663bbe062e040a15a7358229960ff258552c62dce8a49b98f">XV_HDMIRXSS_LOG_EVT_DUMMY</a>.</p>

<p>Referenced by <a class="el" href="xv__hdmirxss_8h.html#abdc056437ab2bb79bc929f7791db5f95">XV_HdmiRxSs_RefClockChangeInit()</a>, <a class="el" href="xv__hdmirxss_8h.html#ad9f6e6e2ae968974f36910a74ede0e2f">XV_HdmiRxSs_Reset()</a>, <a class="el" href="xv__hdmirxss_8h.html#a6156f804fb138799bb3bd9a243dd36cf">XV_HdmiRxSs_SetStream()</a>, <a class="el" href="xv__hdmirxss_8h.html#a506f350efc853af55fab90462724c5fd">XV_HdmiRxSs_Start()</a>, <a class="el" href="xv__hdmirxss_8h.html#a0fa499b01743a173ef1719c45cd40a79">XV_HdmiRxSs_Stop()</a>, and <a class="el" href="group__v__hdmirxss.html#gabddcd7be105900eea60e7c51158ae22d">XV_HdmiRxSs_SubcoreInitHdmiRx()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
